openapi: 3.1.0
info:
  title: PDF Insights API
  description: >
    The PDF Insights API supports three products.   Which product you have a
    license for determines how much of this API is accessible to you.

    <ul> <li> <b>PDF Insights w/Thumbprint</b> - The full API is available. <li>
    <b>PDF Insights</b> - All endpoints are available but Thumbprint scores will
    not return. <li> <b>Thumbprint</b> - Only <a
    href=https://docs.moneythumb.com/pdf-insights/api-reference/other/authenticate>/authenticate</a>
    and <a
    href=https://docs.moneythumb.com/pdf-insights/api-reference/other/uploadpdfs>/uploadpdfs</a>
    endpoints are available. </ul>

    <p>If this is your first time, we strongly encourage you to start with one
    of our Quickstarts.</p>
  version: 1.5
  termsOfService: https://www.moneythumb.com/terms/
  contact:
    name: MoneyThumb Support
    email: support@moneythumb.com
security:
  - bearerAuth: []
servers:
  - url: https://insights.moneythumb.com/api/v1.0
    description: Live Testing
paths:
  /authenticate:
    get:
      summary: Authenticate
      description: >-
        Authenticates with username/password and receive a session token for use
        on other API calls.  Requires `Authorization` and `MT-Product`
        headers.   See
        [Authentication](https://docs.moneythumb.com/pdf-insights/2_authentication)
        page for further details.
      operationId: authenticate
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.  The response body will be a session token.
          content:
            text/plain:
              schema:
                type: string
                description: Session token
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid credentials
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /getapps:
    get:
      summary: List applications
      description: >-
        Retrieves a list of all the applications available to the credentials
        submitted.
      operationId: getapps
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                limit:
                  type: integer
                  description: >-
                    Determines how many results are returned. The default is
                    `20`.
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApplicationInfo'
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /new:
    post:
      summary: Create application
      description: Create a new application or retrieve an existing one.
      operationId: new
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appnumber:
                  type: string
                  description: Customer-assigned application identifier
              required:
                - appnumber
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationInfo'
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /scorecard:
    post:
      summary: Get scorecard
      description: >-
        Retrieve an application's
        [scorecard](https://docs.moneythumb.com/pdf-insights/scorecard).
      operationId: scorecard
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifer.
                sections:
                  type: string
                  description: >-
                    The scorecard sections to return. This field can either
                    contain a single section name or multiple section names. To
                    have multiple sections returned, write each section name
                    separated by commas. For a list of valid section names, see
                    the object name of the section in the [Scorecard Reference
                    page](https://docs.moneythumb.com/pdf-insights/scorecard).
                    This overrides what is defined in the user profile.
                  default: ''
              required:
                - appid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ScoreCardObject_Default'
                  - $ref: '#/components/schemas/ScoreCardObject_JSONObject'
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /makexls:
    post:
      summary: Get scorecard (Excel)
      description: >-
        Retrieve an application's
        [scorecard](https://docs.moneythumb.com/pdf-insights/scorecard).
      operationId: makexls
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ScorecardRequest'
              required:
                - appid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/vnd.ms-excel:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /scorecard/signedUrl:
    post:
      summary: Retrieve signed scorecard URL
      description: >-
        Returns a signed URL that can be used in the browser to open the
        [scorecard](https://docs.moneythumb.com/pdf-insights/scorecard) page
        without signing in. 


        ⚠️ **Warning:** In order to use this URL in an iframe, your domain will
        need to be whitelisted. Please contact
        [support@moneythumb.com](https://www.moneythumb.com/support/) for
        assistance.
      operationId: signedUrl
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifer.
              required:
                - appid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Signed Scorecard URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://insights.moneythumb.com/?token=abc
        '400':
          description: Bad Request - Invalid Inputs
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
  /makecsv:
    post:
      summary: Convert a document
      description: Convert one document and receive its results.
      operationId: makecsv
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MakeCSVRequest'
              required:
                - appnumber
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                type: object
                properties: null
                $ref: '#/components/schemas/MakeCSVRequest'
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '429':
          description: Bad Request - Too Many Requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      An identical file has been uploaded to this application
                      too many times.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /uploadpdfs:
    post:
      summary: Convert multiple documents
      description: >-
        Converts multiple documents, creating an application if one doesn't
        already exist.   Results can be received in multiple ways:


        Callback (preferred): If a URL is specified in the `webhook` parameter,
        the following will occur:
         1. This call will return a `202 ACCEPTED`.
         2. Once conversion is complete, Insights will call the provided webhook URL with the results.

        Sychronous (deprecated): If the `webhook` parameter is not provided, one
        of the following will happen:
         * If the file is text-based, the results will be returned in the response. 
         * If the file requires OCR, `202 ACCEPTED` will be returned and you will need to use other endpoints to retrieve the results.

        While not required, we recommend including the following parameters:
         * `accounttype` - Specifies the type of document. You can also use `autodetect`to automatically pick up different types of documents.
         * `includescorecard` - (true/false) Includes the full underwriting scorecard in the results.
         * `includetransactions` - (true/false) Includes the full transaction list in the results.
         * format - Changes the structure of the JSON for the scorecard (if included).  `jsonobject` is recommended.
         
      operationId: uploadpdfs
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadPDFsRequest'
              required:
                - appnumber
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UploadPDFsResponse_Default'
                  - $ref: '#/components/schemas/UploadPDFsResponse_JSONObject'
        '202':
          description: >-
            File submitted for OCR processing. Returns "Waiting for OCR
            processing to finish."
          content:
            text/plain:
              schema:
                type: string
              examples:
                ocrprocessing:
                  description: OCR Processing
                  value: Waiting for OCR processing to finish.
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '429':
          description: Bad Request - Too Many Requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      An identical file has been uploaded to this application
                      too many times.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
      callbacks:
        Conversion results:
          '{$request.body#/webhook}':
            post:
              summary: Conversion Results
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      oneOf:
                        - $ref: '#/components/schemas/UploadPDFsResponse_Default'
                        - $ref: '#/components/schemas/UploadPDFsResponse_JSONObject'
              responses:
                '200':
                  description: >-
                    Return this code if the callback was received and processed
                    successfully.
        Conversion finished:
          '{$request.body#/webhook}':
            post:
              summary: >-
                Result Id data will be sent, notifying the receiving end that
                processing has finished for files uploaded to the application.
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        data:
                          type: string
              responses:
                '200': >-
                  Returns this code if the callback was received and processed
                  successfully.
  /updatesummary:
    post:
      summary: Update summary
      description: Updates the summary data of a statement.
      operationId: updatesummary
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifier.
                tid:
                  type: string
                  description: Insights-assigned statement identifier.
                startbalance:
                  type: number
                  description: New starting balance.
                debits:
                  type: number
                  description: New total debits.
                credits:
                  type: number
                  description: New total credits.
                endbalance:
                  type: number
                  description: New ending balance.
              required:
                - appid
                - tid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /googlesheets:
    post:
      summary: Update Google Sheets
      description: >-
        Updates scorecard information on an existing Google sheet.


        ⚠️ **Warning:** Contact
        [support@moneythumb.com](https://www.moneythumb.com/support/) for
        assistance to configure Google Sheets for your account.
      operationID: googlesheets
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appnumber:
                  type: string
                  description: Customer-provided identifier for the application.
                  default: ''
                  example: ACME Widgets
                sheetid:
                  type: string
                  description: The unique ID of the Google Sheet to update.
                  required: true
              required:
                - appnumber
                - sheetid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Everything worked ok and sheet has been updated.
        '401':
          description: Authentication Issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '404':
          description: Either appnumber or Google Sheet not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unable to get appnumber Lambda New Test 2.
        '500':
          description: System Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
  /transactions:
    post:
      summary: Get transactions
      description: >-
        Retrieve the transactions, either as JSON (structured=true) or CSV
        (structured=false).
      operationId: transactions
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifier
                structured:
                  type: string
                  description: Determines return format, either JSON (true) or CSV (false).
                  default: false
              required:
                - appid
                - tid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountJSON'
            text/csv:
              schema:
                type: string
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /deletestmt:
    post:
      summary: Delete statement
      description: Deletes a statement.
      operationId: deletestmt
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifier
                tid:
                  type: string
                  description: Insights-assigned statement identifier
              required:
                - appid
                - tid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /getresults:
    post:
      summary: Get results
      description: Retrieve the results of a conversion.
      operationId: getresults
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifier.
                includescorecard:
                  type: boolean
                  description: >-
                    Set to `true` to include the Scorecard data in the results. 
                    Please also include the `format` property set to
                    `jsonobject`.
                  default: false
                includetransactions:
                  type: boolean
                  description: >-
                    Set to `true` to include transactions data (JSON format) in
                    results.
                  default: false
                format:
                  type: string
                  description: >-
                    The desired structure of the scorecard section of the JSON
                    reponse. `default` is deprecated.
                  enum:
                    - default
                    - jsonobject
                  default: default
              required:
                - appid
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UploadPDFsResponse_Default'
                  - $ref: '#/components/schemas/UploadPDFsResponse_JSONObject'
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /remaining:
    get:
      summary: Get remaining
      description: Retrieve the number of remaining conversions on your account.
      operationId: remaining
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      responses:
        '200':
          description: Request successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Remaining:
                    type: integer
                    description: The number of remaining conversions.
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
  /ziparchive:
    post:
      summary: Zip Archive
      description: >-
        Retrieves all PDFs in a zip archive file. Optionally, you can watermark
        these retrieved PDFs.
      operationId: ziparchive
      parameters:
        - name: version
          in: path
          description: The version of the API.
          required: true
          schema:
            type: string
            example: '1.0'
            enum:
              - '1.0'
              - '1.1'
              - '1.2'
              - '1.3'
              - '1.4'
              - '1.5'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                appid:
                  type: integer
                  description: Insights-assigned application identifier.
                filenamePattern:
                  type: string
                  description: >-
                    Creates formatted filenames inside the zip.
                    `filenamePattern` creates them by using angle bracket
                    parameters. For example,
                    `bank_statement_<account_number_last_4>_<month_text>.pdf`.


                    To use this file naming format, use any of the following.
                     - `<account_number_last_4>`: Shows the last 4 characters of the account number. 
                     - `<date>`: The date in MMddyyyy format. 
                     - `<month_text>`: The statement's month name. For example, `July`. 
                     - `<year>`: The statement's year. For example, `2025`. 
                     - `<month_num>`: The statement's month in numeric form. For example, `01`, `02`. 

                    **Note:** `bank_statement` is just an example. You can only
                    use any name you want before the format parameters or none
                    at all. The file naming format works either way. 


                    💡 **Tip:** Use whatever characters (such as dashes, spaces,
                    or underscores) between these format parameters to make sure
                    the filenames are easier to read. 
                watermarkLogo:
                  type: string
                  description: >-
                    Creates the watermark logo. When you create a watermark
                    logo, we recommend the following: 
                     - JPG, PNG, or GIF file formats. 
                     - Square dimensions no larger than 1200 pixels on one side. 
                     - No larger than 3MB in file size. 
                watermarkText:
                  type: string
                  description: >-
                    Places an opaque text across the PDF, so you can still read
                    the statement.
                watermarkIdText:
                  type: string
                  description: >-
                    Places small amount of text in the bottom left of the PDF.
                    You can use this `watermarkIdText` to uniquely identify the
                    PDF.
                watermarkIsFlatten:
                  type: boolean
                  description: >-
                    When set to `True`, this turns each page of the PDF into an
                    image, making it difficult to remove the watermark.
                  default: false
                watermarkUrl:
                  type: string
                  description: >-
                    Converts a URL to a QR code and placed in the bottom right
                    of the PDF.
              required:
                - appid
      responses:
        '200':
          description: Request successful.
          content:
            application/vnd.ms-excel:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request - Invalid Input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No file found to process
        '401':
          description: Bad Request - Authentication Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad token
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Encountered an unknown error. It has been reported. Please
                      contact support@moneythumb.com for any questions.
                  requestId:
                    type: string
                    description: Unique identifier for the request, useful for tracing.
        '503':
          description: Server Error - Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service unavailable
components:
  schemas:
    MakeCSVRequest:
      type: object
      properties:
        appnumber:
          type: string
          description: Customer-provided identifier for the application.
          default: ''
          example: ACME Widgets
        pdf-filename:
          type: string
          format: byte
          description: >-
            The file to upload.  Accepts all supported file types, not just
            PDFs.  This property may be repeated to upload multiple files at
            once. Either `pdf-filename` or `jsondata` is required.
        webhook:
          type: string
          description: A URL for Insights to call with the conversion results.
          example: https://yourdomain.com/webhook.php
        accounttype:
          type: string
          description: >-
            The type of document. The choices are `Bank`, `CCard`, `MTJson`,
            `Plaid`, `applicationForm` or `autoDetect`.
          default: Bank
          enum:
            - Bank
            - CCard
            - MTJson
            - Plaid
            - applicationForm
            - autoDetect
        jsondata:
          type: string
          description: >-
            Use this field when sending a JSON text in Plaid Asset Report or
            [MoneyThumb
            format](https://docs.moneythumb.com/pdf-insights/moneythumb-format/mtjson_example).
            When setting this field, also set the `accounttype` field to the
            appropriate corresponding value, `Plaid` or  `MTJson`. Either
            `pdf-filename` or `jsondata` is required.
          default: ''
        language:
          type: string
          description: >-
            The language of a statement.  Uses ISO abbreviations: `en`, `es`,
            `fr`, `de`, `ln`, `pt`, `it`. Only needed when the statement isn't
            in English.
          default: ''
        schema:
          type: string
          description: >-
            Use `plaid` when running a Plaid JSON file.  Required to get results
            for Plaid json files.
          default: ''
          deprecated: true
        readUSdates:
          type: boolean
          description: >-
            Reads US dates. Set to `true` for US Date format (M-D-Y). Set to
            `false` for D-M-Y.
          default: true
        writeUSdates:
          type: boolean
          description: >-
            Writes US dates. Set to `true` for US Date format (M-D-Y). Set to
            `false` for D-M-Y. Set to `true` if you need Euro dates returned as
            US dates.
          default: true
        firstpage:
          type: integer
          description: The first page number to process (if not page 1).
        lastpage:
          type: integer
          description: The last page number to process (if not the last page in document).
        yearoverride:
          type: integer
          description: Sets the year of the statement.
        alloweddiff:
          type: integer
          description: >-
            Sets the value for allowing small balance differences to be ignored.
            Default is `0`. A value such as `100` would mark the statement as
            reconciled if the balances were accurate within `$100.00`.
          default: 0
        logtype:
          type: string
          description: >-
            Sets the type of log to create. The choices are `txt`, `htm` or
            `none`.
          default: htm
        combinelines:
          type: boolean
          description: Combines description lines into one long description.
          default: false
        noneedalphas:
          type: boolean
          description: Recognizes strictly numeric transaction descriptions.
          default: false
        spacingfactor:
          type: number
          description: Adjusts how much distance is considered a space.
          default: 1
        doocrfile:
          type: boolean
          description: >-
            Run OCR. Use with caution. Intended for manual use. Set to `true`
            when initial processing of a statement does not return correct
            results.
          default: false
        fixedcolumns:
          type: boolean
          description: >-
            Sets whether standard CSV columns are used. If not set, then the
            columns will appear in the same order found in the PDF file.
          default: false
          deprecated: true
        neverocr:
          type: boolean
          description: Never runs OCR. Set to `true` to never run OCR.
          default: false
        asyncocr:
          type: boolean
          description: >-
            Only set to `true` to have an email sent at the completion of an OCR
            conversion.
          default: true
        accountseqno:
          type: integer
          description: >-
            For statements with multiple accounts, set which accounts to
            process. Set to `-1` to process all accounts. To process a specific
            account, use the integer that corresponds to order of appearance for
            that account. For example, to process the 2nd account, use `2`.
          default: -1
          format: int32
        monthseqno:
          type: integer
          description: >-
            For files with multiple statements, set which statement to process.
            Set to `-1` to process all statements. To process a specific
            statement, use the integer that corresponds to order of appearance
            for that statement. For example, to process the 2nd statement, use
            `2`.
          default: -1
        readempty:
          type: boolean
          description: Set to `true` to show statements with no transactions.
          default: false
        finduntrue:
          type: boolean
          description: Set to `true` to automatically find untrue transactions.
          default: false
        customerid:
          type: string
          description: TODP The reseller customer ID.
          default: ''
    UploadPDFsRequest:
      type: object
      properties:
        appnumber:
          type: string
          description: Customer-provided identifier for the application.
          default: ''
          example: ACME Widgets
        appid:
          type: integer
          description: Insights-generated identifier for the application.
          example: 123
          deprecated: true
        pdf-filename:
          type: string
          format: byte
          description: >-
            The file to upload.  Accepts all supported file types, not just
            PDFs.  This property may be repeated to upload multiple files at
            once. Either `pdf-filename` or `jsondata` is required.
        webhook:
          type: string
          description: A URL for Insights to call with the conversion results.
          example: https://yourdomain.com/webhook.php
        whonlynotify:
          type: boolean
          description: >-
            Send the webhook only a completion notification (true) or the full
            results (false)
          default: false
        accounttype:
          type: string
          description: >-
            The type of document. The choices are `Bank`, `CCard`, `MTJson`,
            `Plaid`, `applicationForm` or `autoDetect`.
          default: Bank
          enum:
            - Bank
            - CCard
            - MTJson
            - Plaid
            - applicationForm
            - autoDetect
        jsondata:
          type: string
          description: >-
            Use this field when sending a JSON text in Plaid Asset Report or
            [MoneyThumb
            format](https://docs.moneythumb.com/pdf-insights/moneythumb-format/mtjson_example).
            When setting this field, also set the `accounttype` field to the
            appropriate corresponding value, `Plaid` or `MTJson`. Either
            `pdf-filename` or `jsondata` is required.
          default: ''
        includescorecard:
          type: boolean
          description: >-
            Set to `true` to include the Scorecard data in the results.  Please
            also include the 'format' property set to 'jsonobject'
          default: false
        includetransactions:
          type: boolean
          description: Set to `true` to include transactions data (JSON format) in results.
          default: false
        includebalance:
          type: boolean
          description: >-
            Set to `true` to include the running balance for each transaction.
            Only use when `includetransactions` is set to `true`.
          default: false
        format:
          type: string
          description: >-
            The desired structure of the scorecard section of the JSON reponse.
            `default` is deprecated.
          enum:
            - default
            - jsonobject
          default: default
        language:
          type: string
          description: >-
            The language of a statement.  Uses ISO abbreviations: `en`, `es`,
            `fr`, `de`, `ln`, `pt`, `it`. Only needed when the statement isn't
            in English.
          default: ''
        schema:
          type: string
          description: >-
            Use `plaid` when running a Plaid JSON file.  Required to get results
            for Plaid json files.
          default: ''
          deprecated: true
        readUSdates:
          type: boolean
          description: >-
            Reads US dates. Set to `true` for US Date format (M-D-Y). Set to
            `false` for D-M-Y.
          default: true
        writeUSdates:
          type: boolean
          description: >-
            Writes US dates. Set to `true` for US Date format (M-D-Y). Set to
            `false` for D-M-Y. Set to `true` if you need Euro dates returned as
            US dates.
          default: true
        firstpage:
          type: integer
          description: The first page number to process (if not page 1).
        lastpage:
          type: integer
          description: The last page number to process (if not the last page in document).
        yearoverride:
          type: integer
          description: Sets the year of the statement.
        alloweddiff:
          type: integer
          description: >-
            Sets the value for allowing small balance differences to be ignored.
            Default is `0`. A value such as `100` would mark the statement as
            reconciled if the balances were accurate within `$100.00`.
          default: 0
        logtype:
          type: string
          description: >-
            Sets the type of log to create. The choices are `txt`, `htm` or
            `none`.
          default: htm
        combinelines:
          type: boolean
          description: Combines description lines into one long description.
          default: false
        noneedalphas:
          type: boolean
          description: Recognizes strictly numeric transaction descriptions.
          default: false
        spacingfactor:
          type: number
          description: Adjusts how much distance is considered a space.
          default: 1
        doocrfile:
          type: boolean
          description: >-
            Run OCR. Use with caution. Intended for manual use. Set to `true`
            when initial processing of a statement does not return correct
            results.
          default: false
        fixedcolumns:
          type: boolean
          description: >-
            Sets whether standard CSV columns are used. If not set, then the
            columns will appear in the same order found in the PDF file.
          default: false
          deprecated: true
        neverocr:
          type: boolean
          description: Never runs OCR. Set to `true` to never run OCR.
          default: false
        asyncocr:
          type: boolean
          description: >-
            Only set to `true` to have an email sent at the completion of an OCR
            conversion.
          default: true
        accountseqno:
          type: integer
          description: >-
            For statements with multiple accounts, set which accounts to
            process. Set to `-1` to process all accounts. To process a specific
            account, use the integer that corresponds to order of appearance for
            that account. For example, to process the 2nd account, use `2`.
          default: -1
          format: int32
        monthseqno:
          type: integer
          description: >-
            For files with multiple statements, set which statement to process.
            Set to `-1` to process all statements. To process a specific
            statement, use the integer that corresponds to order of appearance
            for that statement. For example, to process the 2nd statement, use
            `2`.
          default: -1
        readempty:
          type: boolean
          description: Set to `true` to show statements with no transactions.
          default: false
        finduntrue:
          type: boolean
          description: Set to `true` to automatically find untrue transactions.
          default: false
        sections:
          type: string
          description: >-
            The scorecard sections to return. This field can either contain a
            single section name or multiple section names. To have multiple
            sections returned, write each section name separated by commas. For
            a list of valid section names, see the object name of the section in
            the [Scorecard Reference
            page](https://docs.moneythumb.com/pdf-insights/scorecard). This
            overrides what is defined in the user profile.
          default: ''
        showtranstype:
          type: boolean
          description: >-
            Set to `true` to show all transaction amounts as positive and
            include debit/credit in the `type` field. Only use when
            `includetransactions` is set to `true`.
          default: false
        customerid:
          type: string
          description: The reseller customer ID.
          default: ''
        owner:
          type: string
          description: >-
            The owner or company name of the applicant. This is only used in
            combination with `appnumber`.
          default: ''
          example: ACME Widgets
        userdata:
          type: string
          description: >-
            The customer provided meta data to return with response. Must be
            valid JSON. Limited to 250 characters.
          default: ''
    ScorecardRequest:
      type: object
      properties:
        appid:
          type: integer
          description: Insights-generated identifier for the application.
          example: 123
        format:
          type: string
          description: >-
            The desired structure of the scorecard section of the JSON reponse.
            `default` is deprecated.
          enum:
            - default
            - jsonobject
          default: default
        sections:
          type: string
          description: >-
            The scorecard sections to return. This field can either contain a
            single section name or multiple section names. To have multiple
            sections returned, write each section name separated by commas. For
            a list of valid section names, see the object name of the section in
            the [Scorecard Reference
            page](https://docs.moneythumb.com/pdf-insights/scorecard). This
            overrides what is defined in the user profile.
          default: ''
    ApplicationInfo:
      type: object
      properties:
        appnumber:
          type: string
          description: The unique application number assigned by the user.
        appid:
          type: integer
          description: The unique application ID assigned by the system.
          format: int32
        naccounts:
          type: integer
          description: The number of accounts.
          format: int32
        owner:
          type: string
          description: Application owner
        totalstatements:
          type: integer
          description: The number of statements in the application.
          format: int32
        totalstatements_reconciled:
          type: integer
          description: The number of statements that reconcile.
          format: int32
        totaltaxforms:
          type: integer
          description: The number of tax forms.
          format: int32
        totaltaxreturns:
          type: integer
          description: The number of tax returns.
          format: int32
        address1:
          type: string
          description: The first line of address.
        address2:
          type: string
          description: The second line of address.
        citystate:
          type: string
          description: The city and state of address.
        city:
          type: string
          description: The city of the address.
        state:
          type: string
          description: The state of the address.
        zip:
          type: string
          description: The zip code of the address.
        expfactor:
          type: string
          description: Expense factor
        accountlist:
          type: array
          description: 'List of accounts: `account number` `statement date`.'
          items:
            type: string
            description: 'List of accounts: `account number` `statement date`.'
    DocumentResult:
      type: object
      properties:
        fileConversionId:
          type: integer
          description: Internal use only.
        detectedDocTypeText:
          type: string
          description: >-
            The document type that's detected. They can be `Bank Statement`,
            `Credit Card Statement`, `Application`, `Investment Statement`, or
            `Tax Form`.
        processedDocTypeText:
          type: string
          description: >-
            The document type flagged when processed. They can be `Bank
            Statement`, `Credit Card Statement`, `Application`, `Investment
            Statement`, or `Tax Form`.
        reconciled:
          type: boolean
          description: Shows whether the statement reconciles.
        donegate:
          type: boolean
          description: >-
            Shows whether the statement values need to be negated for the
            statement to balance. Typically `true` for credit card statements."
        columnsValid:
          type: boolean
          description: >-
            For multi-statement PDFs, shows whether the columns for each
            statement match.
        fdicaddress:
          type: string
          description: Shows the physical address of the bank.
        fdiccity:
          type: string
          description: Shows the city where the bank is located.
        fdicstate:
          type: string
          description: Shows the state where the bank is located.
        fdiczipcode:
          type: string
          description: Shows the zip code of the bank.
        nsfcount:
          type: integer
          description: The number of NSF transactions and overdraft transactions.
          format: int32
        address1:
          type: string
          description: The first line of address.
        address2:
          type: string
          description: The second line of address.
        name:
          type: string
          description: The account owner name.
        company:
          type: string
          description: The account owner company.
        city:
          type: string
          description: The city from address.
        state:
          type: string
          description: The state or province from address.
        postalcode:
          type: string
          description: Postal code
        country:
          type: string
          description: Country
        remaining:
          type: integer
          description: The number of remaining conversions.
          format: int32
        transactions:
          type: object
          description: >-
            Not populated, use transactions API endpoint to retrieve
            transactions data.
        suggestion:
          type: string
          description: Suggestion(s) to help improve conversion results for PDF statement.
        pagecount:
          type: integer
          description: The number of pages in PDF.
          format: int32
        email:
          type: string
          description: The email for sending notifications when finished OCR processing.
        webhook:
          type: string
          description: >-
            The webhook for sending the results summary when finished
            converting.
        returnType:
          type: integer
          description: The output type for results. It's normally 3 for JSON output.
          format: int32
        minResolution:
          type: integer
          description: The minimum resolution found in an image.
          format: int32
        maxResolution:
          type: integer
          description: The maximum resolution found in an image.
          format: int32
        accounttype:
          type: integer
          description: The account type. 0=Bank; 2=Credit Card.
          format: int32
        fraudscore:
          type: integer
          description: The Thumbprint fraud score.
          format: int32
        producer:
          type: string
          description: The software that produced the PDF.
        tpreasonsIndexes:
          type: array
          items:
            type: integer
            format: int32
        tpreasons:
          type: array
          description: The list of reasons for the Thumbprint score.
          items:
            type: string
            description: The list of reasons for the Thumbprint score.
        bankphones:
          type: array
          description: The list of phone numbers found in the statement.
          items:
            type: string
            description: The list of phone numbers found in the statement.
        cdate:
          type: string
          description: The PDF creation date.
          format: date
        mdate:
          type: string
          description: The PDF last modified date.
          format: date
        isMonthToDate:
          type: boolean
          description: The statement is Month To Date.
        isBusiness:
          type: boolean
          description: >-
            Shows whether this is a business account. This is inferred from the
            owner name or account title.
        accounttitle:
          type: string
        accounttypestr:
          type: string
          description: >-
            A string with the account type as gleaned from the input, account
            titles, checks, etc. This could be either Checking, Savings,
            MoneyMarket, Line of Credit, or CCard.
        form:
          $ref: '#/components/schemas/FormMCA'
        currencycode:
          type: string
        language:
          type: string
        chargevalue:
          type: integer
          format: int32
        statementid:
          type: integer
          description: The ID statement (for PDF Insights only).
          format: int32
        detectedDocType:
          type: integer
          format: int32
        processedDocType:
          type: integer
          format: int32
        uncounted:
          type: integer
          format: int32
        uselessPages:
          type: integer
          format: int32
        fail:
          type: boolean
        likelyMissingTransactions:
          type: boolean
          description: Shows whether we detect transactions are missing from the statement.
        isStrongAccountNo:
          type: boolean
          description: Shows that it's very likely the account number is correct.
        filePreviouslySeen:
          type: string
          description: Returns the `numInLast3Days` field.
        numInLast3Days:
          type: integer
          description: Shows the number of times a file was seen in the last 3 days.
        numTransactions:
          type: integer
          description: >-
            The number of transactions. If it's a negative number, then an error
            occurred.
          format: int32
        balancesValid:
          type: boolean
          description: Both starting and ending balances were found in the PDF statement.
        numCredits:
          type: integer
          description: The number of credits.
          format: int32
        numDebits:
          type: integer
          description: The number of debits.
          format: int32
        startBalance:
          type: number
          description: >-
            The starting balance of the statement, if found. Otherwise, it's
            0.00.
        endBalance:
          type: number
          description: The ending balance of the statement, if found. Otherwise, it's 0.00.
        endBalanceCalc:
          type: number
          description: >-
            The calculated ending balance of the statement (startBalance +
            totCredits - totDebits).
        totCredits:
          type: number
          description: The total of all the credits in the statement.
        totDebits:
          type: number
          description: The total of all the debits in the statement.
        accountNumber:
          type: string
          description: Account number
        bankName:
          type: string
          description: Bank name. If not found it will be Unknown.
        bankURL:
          type: string
          description: Bank URL
        accountOwner:
          type: array
          description: The account owner address block from the statement.
          items:
            type: string
            description: The account owner address block from the statement.
        headerValid:
          type: boolean
          description: null
        negate:
          type: boolean
          description: null
        trackingId:
          type: string
          description: >-
            The user-provided or internally generated ID for tracking
            conversion.
        firstDate:
          type: string
          description: The date of the first transaction (in ISO 8601 format).
          format: date
        lastDate:
          type: string
          description: The date of the last transaction (in ISO 8601 format).
          format: date
        startDate:
          type: string
          description: >-
            The start date of the statement (in ISO 8601 format). If not found,
            it defaults to `firstDate`.
          format: date
        endDate:
          type: string
          description: >-
            The end date of the statement (in ISO 8601 format). If not found, it
            defaults to `lastDate`.
          format: date
        numMonths:
          type: integer
          description: The number of months in the PDF.
          format: int32
        monthSequence:
          type: integer
          description: The month sequence, starting with 0 for 1st month.
          format: int32
        numAccounts:
          type: integer
          description: The number of accounts.
          format: int32
        accountSequence:
          type: integer
          description: The account sequence, starting with 0 for 1st account.
          format: int32
        ocr:
          type: boolean
          description: Shows whether it was processed using OCR.
        image:
          type: boolean
          description: Show whether PDF was an image (not text-based).
        docType:
          type: integer
          description: >-
            The document type. 0 for bank or credit card statement. 1 for tax
            form.
          format: int32
        numTypos:
          type: integer
          description: The number of typos fixed by PDF+ PinPoint.
          format: int32
        suspectCount:
          type: integer
          description: The number of currency values with low-confidence digits.
          format: int32
        webReport:
          type: boolean
          description: Shows whether PDF was a web report.
        overDraftLimit:
          type: number
          description: Shows the overdraft limit (if found) in the statement.
        previewRequired:
          type: boolean
          description: >-
            Shows whether preview is recommended due to typos found or if
            `suspectCount` is more than 0.
        monthToDate:
          type: boolean
          writeOnly: true
      description: The Statement Results Object.
    ConverterResultsServer:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/DocumentResult'
        logurl:
          type: string
          description: The location of log file for conversions.
        csvurl:
          type: string
          description: The location of CSV file of transactions.
          deprecated: true
        error:
          type: string
          description: Error message
        tid:
          type: string
          description: The internal tracking ID.
        outputurl:
          type: string
          description: The URL of the output (for Accounting applications only).
        statementid:
          type: integer
          description: Use `statementid` in results object instead.
          format: int32
          deprecated: true
        convertedstatements:
          type: integer
          description: The count of converted statements.
          format: int32
        convertedtaxforms:
          type: integer
          description: The count of converted tax forms.
          format: int32
        taxform:
          type: string
          description: The tax form number.
        taxsales:
          type: string
          description: Tax sales
        taxgross:
          type: string
          description: Tax gross
        taxincome:
          type: string
          description: Tax income
        taxableincome:
          type: string
          description: Taxable income
        statementseq:
          type: integer
          description: >-
            The sequence number of this statement in the last conversion list (0
            based).
          format: int32
        appinfo:
          $ref: '#/components/schemas/ApplicationInfo'
        transactions:
          $ref: '#/components/schemas/Transaction'
        userdata:
          $ref: '#/components/schemas/JsonNode'
      description: Converter Results Object
    FormMCA:
      type: object
      properties:
        legalName:
          type: string
        dba:
          type: string
        federalTaxId:
          type: string
        dateBusStart:
          type: string
        legalForm:
          type: string
        typeOfBiz:
          type: string
        stateOfInc:
          type: string
        prodOrServ:
          type: string
        physAddrStreet:
          type: string
        physAddrCity:
          type: string
        physAddrState:
          type: string
        physAddrZip:
          type: string
        phone:
          type: string
        mobile:
          type: string
        email:
          type: string
        website:
          type: string
        amountRequested:
          type: string
        grossAnnualRev:
          type: string
        grossCcReceipts:
          type: string
        owner1Name:
          type: string
        owner1Title:
          type: string
        owner1Perc:
          type: string
        owner1Street:
          type: string
        owner1City:
          type: string
        owner1State:
          type: string
        owner1Zip:
          type: string
        owner1DOB:
          type: string
        owner1SSN:
          type: string
        owner1Phone:
          type: string
        owner1Email:
          type: string
        owner1CredScore:
          type: string
        owner2Name:
          type: string
        owner2Title:
          type: string
        owner2Perc:
          type: string
        owner2Street:
          type: string
        owner2City:
          type: string
        owner2State:
          type: string
        owner2Zip:
          type: string
        owner2DOB:
          type: string
        owner2SSN:
          type: string
        owner2Phone:
          type: string
        owner2Email:
          type: string
        owner2CredScore:
          type: string
        submissionId:
          type: integer
          format: int32
        loanCorp:
          type: string
        fields:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
        nbFoundFields:
          type: integer
          format: int32
    JsonNode:
      type: object
      description: The JSON data provided via userdata in the API call.
    ResultId:
      type: object
      properties:
        resids:
          type: array
          description: The array of results IDs, one for each statement that was processed.
          items:
            type: string
            description: >-
              The array of results IDs, one for each statement that was
              processed.
        appnumber:
          type: string
          description: The unique application number provided in the originating API call.
        appid:
          type: integer
          description: The unique internal application ID.
          format: int32
      description: >-
        Results Identification object. This is used to notify a webhook when
        processing has finished for an application.
    Balance:
      type: object
      properties:
        acctid:
          type: string
        balance:
          type: number
        od_balance:
          type: number
        true_balance:
          type: number
    Cash_Flow:
      type: object
      properties:
        acctid:
          type: string
        cashflow:
          type: number
        true_cashflow:
          type: number
    MCACompany:
      type: object
      properties:
        company:
          type: string
          description: MCA company name
          example: ACME MCA
        withdrawalcount:
          type: integer
          description: Number of withdrawals
          example: 6
        withdrawaltotal:
          type: number
          description: Currency value of withdrawals
          example: '-23042.12'
        withdrawalfrequency:
          type: string
          description: Frequency of withdrawals
          example: Every Other Day
          enum:
            - Daily
            - Every Other Day
            - Weekly
            - Monthly
        lastwithdrawaldate:
          type: string
          description: Date of the latest withdrawal
          example: '2020-03-15'
        lastwithdrawalamount:
          type: number
          description: Currency value of the latest withdrawal
          example: '-6085.23'
        depositcount:
          type: integer
          description: Number of deposits
          example: 2
        deposittotal:
          type: number
          description: Currency value of deposits
          example: '20523.53'
        depositdates:
          type: string
          description: List of YYYY-MM-DD formatted dates of deposits
          example: 2023-03-09, 2023-03-15
        lastdepositdate:
          type: number
          description: The last deposit date.
          example: '2023-03-15'
        lastdepositamount:
          type: number
          description: The last deposit amount.
          example: '6000.00'
        withholdpercent:
          type: string
          description: Percent withholding
          example: 57%
        term:
          type: number
          example: '150.31'
        months:
          type: array
          items:
            type: object
            properties:
              month:
                type: string
                description: The first day of the month
                example: '2020-03-01'
              workdays:
                type: integer
                description: Number of work days in the month
                example: 22
              withdrawalcount:
                type: integer
                description: Number of withdrawals
                example: 6
              withdrawaltotal:
                type: number
                description: Currency value of withdrawals
                example: '-23042.12'
              withdrawalfrequency:
                type: string
                description: Frequency of withdrawals
                example: Every Other Day
                enum:
                  - Daily
                  - Every Other Day
                  - Weekly
                  - Monthly
              lastwithdrawaldate:
                type: string
                description: Date of the latest withdrawal
                example: '2020-03-15'
              lastwithdrawalamount:
                type: number
                description: Currency value of the latest withdrawal
                example: '-6085.23'
              depositcount:
                type: integer
                description: Number of deposits
                example: 2
              deposittotal:
                type: number
                description: Currency value of deposits
                example: '20523.53'
              depositdate:
                type: string
                example: '2020-03-15'
              withholdpercent:
                type: string
                description: Percent withholding
                example: 57%
              term:
                type: number
                example: '150.31'
    RecoveryCompany:
      type: object
      properties:
        company:
          type: string
          description: Recovery company name
          example: ACME Recovery
        withdrawalcount:
          type: integer
          description: Number of withdrawals
          example: 6
        withdrawaltotal:
          type: number
          description: Currency value of withdrawals
          example: '-23042.12'
        withdrawalfrequency:
          type: string
          description: Frequency of withdrawals
          example: Every Other Day
          enum:
            - Daily
            - Every Other Day
            - Weekly
            - Monthly
        lastwithdrawaldate:
          type: string
          description: Date of the latest withdrawal
          example: '2020-03-15'
        lastwithdrawalamount:
          type: number
          description: Currency value of the latest withdrawal
          example: '-6085.23'
        depositcount:
          type: integer
          description: Number of deposits
          example: 2
        deposittotal:
          type: number
          description: Currency value of deposits
          example: '20523.53'
        withholdpercent:
          type: string
          description: Percent withholding
          example: 57%
        term:
          type: number
          example: '150.31'
        months:
          type: array
          items:
            type: object
            properties:
              month:
                type: string
                description: The first day of the month
                example: '2020-03-01'
              workdays:
                type: integer
                description: Number of work days in the month
                example: 22
              withdrawalcount:
                type: integer
                description: Number of withdrawals
                example: 6
              withdrawaltotal:
                type: number
                description: Currency value of withdrawals
                example: '-23042.12'
              withdrawalfrequency:
                type: string
                description: Frequency of withdrawals
                example: Every Other Day
                enum:
                  - Daily
                  - Every Other Day
                  - Weekly
                  - Monthly
              lastwithdrawaldate:
                type: string
                description: Date of the latest withdrawal
                example: '2020-03-15'
              lastwithdrawalamount:
                type: number
                description: Currency value of the latest withdrawal
                example: '-6085.23'
              depositcount:
                type: integer
                description: Number of deposits
                example: 2
              deposittotal:
                type: number
                description: Currency value of deposits
                example: '20523.53'
              depositdate:
                type: string
                example: '2020-03-15'
              withholdpercent:
                type: string
                description: Percent withholding
                example: 57%
              term:
                type: number
                example: '150.31'
    DailyBalance_JSONObject:
      type: object
      properties:
        event_date:
          type: string
        balances:
          type: array
          items:
            type: object
            properties:
              acctid:
                type: string
                description: Account number
              balance:
                type: number
                description: Balance counting all transactions
              od_balance:
                type: number
                description: Balance counting all transactions and overdrafts
              true_balance:
                type: number
                description: Balance counting all transactions except non-true credits
    declinelist_JSONObject:
      type: object
      properties:
        DT_RowId:
          type: string
        Decline Reason:
          type: string
          description: The reason why a MCA or recovery company is banned.
        Details:
          type: string
          description: The name of the MCA or recovery company.
    DailyCashflow_JSONObject:
      type: object
      properties:
        event_date:
          type: string
        balances:
          type: array
          items:
            type: object
            properties:
              acctid:
                type: string
                description: Account number
              balance:
                type: number
                description: All credits minus all debits
              true_balance:
                type: number
                description: True credits minus all debits
    ScoreCardTransaction_JSONObject:
      type: object
      properties:
        accountidx:
          type: integer
          description: The index of account from `accountslist`.
          format: int32
        id:
          type: integer
          description: The unique ID of the transaction.
          format: int32
        date:
          type: string
          description: The date of the transaction.
          format: date
        description:
          type: string
          description: The description of the transaction.
        amount:
          type: number
          description: The amount of the transaction.
        memo:
          type: string
          description: The memo from the transacation.
        number:
          type: integer
          description: Check number
          format: int32
      description: Transaction Object
    InsightsScoreCardTransactionSectionObject_Default:
      type: object
      properties:
        columns:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              data:
                type: string
        labels:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              name:
                type: string
        data:
          type: array
          items:
            type: object
            properties:
              DT_RowId:
                type: string
              accountidx:
                type: integer
                description: The index of account from `accountslist`.
                format: int32
              id:
                type: integer
                description: The unique ID of the transaction.
                format: int32
              date:
                type: string
                description: The date of the transaction.
                format: date
              description:
                type: string
                description: The description of the transaction.
              amount:
                type: number
                description: The amount of the transaction.
              memo:
                type: string
                description: The memo from the transacation.
              number:
                type: integer
                description: Check number
                format: int32
            description: Transaction Object
    TrueRevenue_Default:
      type: object
      properties:
        columns:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              data:
                type: string
        labels:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              name:
                type: string
        data:
          type: array
          items:
            type: object
            properties:
              '0':
                type: object
                description: Data values matching 0th column.  Repeated for all columns
                properties:
                  revenue:
                    type: number
                  percentChange:
                    type: number
              accountNumber:
                type: string
                description: Account number or Total
                example: '123456789'
    Metadata:
      type: object
      properties:
        someTransactionsExcludedDueToValidationFailures:
          type: boolean
        numFileConversionsInProgress:
          type: integer
        warnings:
          type: string
          example: Section 'combinedsummary' encountered an error.
    MonthlyMCA_JSONObject:
      type: object
      properties:
        month:
          type: date
          description: Date in YYYY-MM-DD format
          example: '2020-03-31'
        workdays:
          type: integer
          description: Number of workdays in the month
          example: 22
        accounts:
          type: array
          items:
            type: object
            properties:
              account:
                type: string
                description: Account number
                example: '12345678'
              lenders:
                type: array
                items:
                  type: object
                  properties:
                    lender:
                      type: string
                      description: Name of the MCA lender
                      example: ACME MCA
                    withdrawalcount:
                      type: integer
                      description: Number of withdrawals
                      example: 5
                    withdrawaltotal:
                      type: number
                      description: Total currency amount of withdrawals
                      example: '-15872.20'
                    deposittotal:
                      type: number
                      description: Total currency amount of deposits
                      example: '20000.00'
                    depositdate:
                      type: string
                      description: List of YYYY-MM-DD formatted dates of deposits
                      example: 2023-03-09, 2023-03-15
                    latestwithdrawalamount:
                      type: number
                      description: Currency amount of latest withdrawalcount
                      example: '511.60'
    MonthlyRecovery_JSONObject:
      type: object
      properties:
        month:
          type: date
          description: The date in YYYY-MM-DD format.
        workdays:
          type: integer
          description: The number of workdays in the month.
        accounts:
          type: array
          items:
            type: object
            properties:
              account:
                type: string
                description: Account numbers
              lenders:
                type: array
                items:
                  type: object
                  properties:
                    lender:
                      type: string
                      description: The name of the recovery company.
                    withdrawalcount:
                      type: integer
                      description: The number of withdrawals.
                      example: 5
                    withdrawaltotal:
                      type: number
                      description: The total currency amount of withdrawals.
                      example: '-15872.20'
                    deposittotal:
                      type: number
                      description: The total currency amount of deposits.
                      example: '20000.00'
                    depositdate:
                      type: string
                      description: List of YYYY-MM-DD formatted dates of deposits.
                      example: 2023-03-09, 2023-03-15
                    latestwithdrawalamount:
                      type: number
                      description: The currency amount of latest withdrawal count.
                      example: '511.60'
    MonthlyNegativeDays_JSONObject:
      type: object
      properties:
        event_date:
          type: string
          description: '2020-03-01'
        negative_days:
          type: array
          items:
            type: object
            properties:
              acctid:
                type: string
                description: Account numbers
                example: 123456789
              negdayscount:
                type: integer
                description: Number of negative days based on all transactions
                example: 2
              odnegdayscount:
                type: integer
                description: Number of negative days, including overdrafts
                example: 2
              truenegdayscount:
                type: integer
                description: Number of negative days based on true credits and all debits
                example: 2
              negdays:
                type: array
                description: Days on which the balance was negative
                items:
                  type: string
                  example: '2020-03-15'
              odnegdays:
                type: array
                description: Days on which the balance was negative, including overdrafts
                items:
                  type: string
                  example: '2020-03-15'
              truenegdays:
                type: array
                description: >-
                  Days on which the balance was negative, excluding non-true
                  credits
                items:
                  type: string
                  example: '2020-03-15'
    Revenue_Statistics:
      type: object
      properties:
        statistic:
          type: array
          items:
            type: string
      description: Average monthly and annualized revenue statistics.
    ScoreCardObject_Default:
      type: object
      title: Default
      properties:
        _metadata:
          $ref: '#/components/schemas/Metadata'
        metrics:
          type: object
          properties:
            metricdata:
              type: array
              items:
                type: string
              description: Average monthly and annualized revenue statistics.
        debtsummary:
          description: Monthly summary of loan withdrawals by type.
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  month:
                    type: string
                    description: Month
                  mca:
                    type: string
                    description: Total MCA withdrawals for the month.
                  nonmcaloan:
                    type: string
                    description: Total amount of Non-MCA withdrawals for the month.
                  autofinance:
                    type: string
                    description: Total auto-finance loan withdrawals for the month.
                  studentloan:
                    type: string
                    description: Total student loan withdrawals for the month.
                  mortgage:
                    type: string
                    description: Total mortgage withdrawals for the month.
                  personalloan:
                    type: string
                    description: Total personal loan withdrawals for the month.
                  total:
                    type: string
                    description: Total amount of debt withdrawals for the month.
        accountslist:
          $ref: '#/components/schemas/Statements_Summary_Default'
        combinedsummary:
          $ref: '#/components/schemas/Combined_Summary_Default'
        truerev6mo:
          $ref: '#/components/schemas/TrueRevenue_Default'
        truerev12mo:
          $ref: '#/components/schemas/TrueRevenue_Default'
        taxscorelist:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  source:
                    type: string
                    description: Location of the value
                    example: Income Statement
                  form_1120_(2014):
                    type: number
                    description: Value
                    example: '1205.20'
        thumbprints:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  account:
                    type: string
                    description: Account number
                    example: '123456789'
                  end_date:
                    type: string
                    description: Last day of statement
                    example: '2020-03-31'
                  thumbprint_score:
                    type: integer
                    description: Thumbprint score
                    example: '980'
                  contributing_factors:
                    type: string
                    description: >-
                      New-line delimited list of contributors to the Thumbprint
                      score
                    example: Currency column positions...\nPDF producer not...
                  statement_id:
                    type: integer
                    description: Statement identifier
                    example: 123
        monthlymca:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  month:
                    type: date
                    description: Date in YYYY-MM-DD format
                    example: '2020-03-31'
                  workdays:
                    type: integer
                    description: Number of workdays in the month
                    example: 22
                  account:
                    type: string
                    description: Account number
                    example: '12345678'
                  lender:
                    type: string
                    description: Name of the MCA lender
                    example: ACME MCA
                  withdrawal_count:
                    type: integer
                    description: Number of withdrawals
                    example: 5
                  withdrawal_total:
                    type: number
                    description: Total currency amount of withdrawals
                    example: '-15872.20'
                  deposit_total:
                    type: number
                    description: Total currency amount of deposits
                    example: '20000.00'
                  deposit_dates:
                    type: string
                    description: List of YYYY-MM-DD formatted dates of deposits
                    example: 2023-03-09, 2023-03-15
                  latest_withdrawal_amount:
                    type: number
                    description: Currency amount of latest withdrawalcount
                    example: '511.60'
        mcacompanies:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  lender:
                    type: string
                    description: Name of the MCA lender.
                    example: ACME MCA
                  month:
                    type: date
                    description: Date in YYYY-MM-DD format.
                    example: '2020-03-31'
                  workdays:
                    type: integer
                    description: Number of workdays in the month.
                    example: 22
                  term:
                    type: number
                    example: '150.51'
                  withdrawal_count:
                    type: integer
                    description: The number of withdrawals.
                    example: 5
                  withdrawal_total:
                    type: number
                    description: Total currency amount of withdrawals.
                    example: '-15872.20'
                  withdrawal_percent:
                    type: number
                    example: 19%
                  deposit_count:
                    type: integer
                    description: Number of deposits.
                    example: '1'
                  deposit_total:
                    type: number
                    description: Total currency amount of deposits.
                    example: '20000.00'
                  withdrawal_frequency:
                    type: string
                    description: Frequency of withdrawals.
                    enum:
                      - Daily
                      - Every Other Day
                      - Weekly
                      - Monthly
                    example: Every Other Day
                  deposit_dates:
                    type: string
                    description: List of YYYY-MM-DD formatted dates of deposits
                    example: 2023-03-09, 2023-03-15
                  last_withdrawal_date:
                    type: string
                    description: Date of latest withdrawal.
                    example: '2020-03-15'
                  last_withdrawal_amount:
                    type: number
                    description: Currency amount of latest withdrawal count.
                    example: '511.60'
        recoverycompanies:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  lender:
                    type: string
                    description: Name of the MCA lender
                    example: ACME MCA
                  month:
                    type: date
                    description: Date in YYYY-MM-DD format
                    example: '2020-03-31'
                  workdays:
                    type: integer
                    description: Number of workdays in the month
                    example: 22
                  term:
                    type: number
                    example: '150.51'
                  withdrawal_count:
                    type: integer
                    description: Number of withdrawals
                    example: 5
                  withdrawal_total:
                    type: number
                    description: Total currency amount of withdrawals
                    example: '-15872.20'
                  withdrawal_percent:
                    type: number
                    example: 19%
                  deposit_count:
                    type: integer
                    description: Number of deposits
                    example: '1'
                  deposit_total:
                    type: number
                    description: Total currency amount of deposits
                    example: '20000.00'
                  withdrawal_frequency:
                    type: string
                    description: Frequency of withdrawals
                    enum:
                      - Daily
                      - Every Other Day
                      - Weekly
                      - Monthly
                    example: Every Other Day
                  deposit_dates:
                    type: string
                    description: List of YYYY-MM-DD formatted dates of deposits
                    example: 2023-03-09, 2023-03-15
                  last_withdrawal_date:
                    type: string
                    description: Date of latest withdrawal
                    example: '2020-03-15'
                  last_withdrawal_amount:
                    type: number
                    description: Currency amount of latest withdrawalcount
                    example: '511.60'
        dailybalance:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  date:
                    type: string
                    description: Last day of the month
                    example: '2020-03-31'
                  12345678_balance:
                    type: number
                    description: Balance of account 12345678.  Repeated for each account.
                    example: '12345.67'
                  12345678_true_balance:
                    type: number
                    description: >-
                      True balance of account 12345678.  Repeated for each
                      account.
                    example: '12345.67'
        declinelist:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  decline_reason:
                    type: string
                    description: The reason why a MCA or recovery company is banned.
                    example: Unacceptable MCA
                  details:
                    type: number
                    description: The name of the MCA or recovery company.
                    example: IOU Financial
        dailycashflow:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  date:
                    type: string
                    description: Day
                    example: '2020-03-31'
                  12345678_cash_flow:
                    type: number
                    description: Cashflow for account 12345678.  Repeated for each account.
                    example: '12345.67'
                  12345678_true_cash_flow:
                    type: number
                    description: >-
                      Cashflow for account 12345678, excluding non-true
                      credits.  Repeated for each account.
                    example: '12345.67'
        monthlycashflow:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  month:
                    type: string
                    description: Month and year
                    example: February 2020
                  12345678_cash_flow:
                    type: number
                    description: Cashflow for account 12345678.  Repeated for each account.
                    example: '12345.67'
                  12345678_true_cash_flow:
                    type: number
                    description: >-
                      Cashflow for account 12345678, excluding non-true
                      credits.  Repeated for each account.
                    example: '12345.67'
        monthlynegativedays:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  month:
                    type: string
                    description: Month and year
                    example: February 2020
                  combined_total_count:
                    type: integer
                    example: '1'
                  combined_weekdays_with_negative_balance:
                    type: integer
                    example: '1'
                  12345678_total_count:
                    type: number
                    example: '1'
                  12345678_weekdays_with_negative_balance:
                    type: number
                    example: '1'
                  12345678_true_total_count:
                    type: number
                    example: '1'
                  12345678_weekdays_with_true_negative_balance:
                    type: number
                    example: '1'
        monthlyrecovery:
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  month:
                    type: date
                    description: Date in YYYY-MM-DD format
                    example: '2020-03-31'
                  workdays:
                    type: integer
                    description: Number of workdays in the month
                    example: 22
                  account:
                    type: string
                    description: Account number
                    example: '12345678'
                  lender:
                    type: string
                    description: Name of the Recovery company
                    example: ACME Recovery
                  withdrawal_count:
                    type: integer
                    description: Number of withdrawals
                    example: 5
                  withdrawal_total:
                    type: number
                    description: Total currency amount of withdrawals
                    example: '-15872.20'
                  deposit_total:
                    type: number
                    description: Total currency amount of deposits
                    example: '20000.00'
                  deposit_dates:
                    type: string
                    description: List of YYYY-MM-DD formatted dates of deposits
                    example: 2023-03-09, 2023-03-15
                  latest_withdrawal_amount:
                    type: number
                    description: Currency amount of latest withdrawalcount
                    example: '511.60'
        debittrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        creditcardaccountpayment:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        lifeinsurance:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        investmentdebits:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mcarefund:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mcanorefunds:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        creditcardprocessortrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        installmentpayment:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        ecommercetrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        autofinancepayments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        studentloanpayments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mortgagepayments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        personalloanpayments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        combotrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mcapayments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        otherdebits:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mobilepaymentsdebits:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        nefariouswithdrawals:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        debtcollectortransactions:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        constructiondebits:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        nonmcaloans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        atmwithdrawals:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        insurance:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        reptrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mcatrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mcafees:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        nsftrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        overtrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        credittrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        truecredittrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        untruecredittrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        xferitrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        xferotrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        largetrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        largecredittrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        returnedtrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        largeelectronictrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        xfertrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        truetrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        untruetrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        recoverytrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        casinotrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        investments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        mobilepayments:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        paymentprocessortrans:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        healthcareclaims:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        factoring:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        nefarioustransactions:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        alltransactions:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        otherfinancingtransactions:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        nontransactionitems:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        payroll:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        tolls:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        nondescriptrevenue:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
        chineseexposure:
          $ref: >-
            #/components/schemas/InsightsScoreCardTransactionSectionObject_Default
    ScoreCardObject_JSONObject:
      type: object
      title: JSONObject
      properties:
        _metadata:
          $ref: '#/components/schemas/Metadata'
        Revenue Statistics:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              monthly:
                type: number
              annual:
                type: number
          description: Average monthly and annualized revenue statistics.
        Debt Summary:
          description: Monthly summary of loan withdrawals by type.
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  DT_RowId:
                    type: string
                  Month:
                    type: string
                    description: Month
                  MCA:
                    type: string
                    description: Total MCA withdrawals for the month.
                  Non-MCA Loan:
                    type: string
                    description: Total amount of Non-MCA withdrawals for the month.
                  Auto Finance:
                    type: string
                    description: Total auto-finance loan withdrawals for the month.
                  Student Loan:
                    type: string
                    description: Total student loan withdrawals for the month.
                  Mortgage:
                    type: string
                    description: Total mortgage withdrawals for the month.
                  Personal Loan:
                    type: string
                    description: Total personal loan withdrawals for the month.
                  Total:
                    type: string
                    description: Total amount of debt withdrawals for the month.
        Statements Summary:
          type: array
          items:
            $ref: '#/components/schemas/Statements_Summary_JSONObject'
        Debit Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Credit Card Account Payment:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Life Insurance:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Investment Debits:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        MCA Refund:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        MCA Without Refunds:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Credit Card Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Installment Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        ecommercetrans:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Auto Finance Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Student Loan Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Mortgage Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Personal Loan Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Combo (NSF, OD, Return, & Stop):
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        MCA Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Other Debits:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Mobile Payments Debits:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Nefarious Withdrawals:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Debt Collector Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Construction Related Debits:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Combined Account Summary:
          type: array
          items:
            type: object
        Non-MCA Loans:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        ATM Withdrawals:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Average True Revenue (6 month):
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  accountNumber:
                    type: string
                  DT_RowId:
                    type: string
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        startDate:
                          type: string
                        endDate:
                          type: string
                        trueRevenueAverage:
                          type: number
                        percentChange:
                          type: number
        Average True Revenue (12 month):
          type: object
          properties:
            labels:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  name:
                    type: string
            columns:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  data:
                    type: string
            data:
              type: array
              items:
                type: object
                properties:
                  accountNumber:
                    type: string
                  DT_RowId:
                    type: string
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        startDate:
                          type: string
                        endDate:
                          type: string
                        trueRevenueAverage:
                          type: number
                        percentChange:
                          type: number
        Tax Analysis:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
                description: Source of the value
                example: Income Statement
              form_1120_2014:
                type: number
                description: The value.  Repeated for each form included
                example: 1500.23
        Insurance:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Thumbprints:
          type: array
          items:
            $ref: '#/components/schemas/Thumbprint'
        Monthly MCA:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyMCA_JSONObject'
        Repeating Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        MCA Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        MCA Fees:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        NSF Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Overdraft Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Daily Balances:
          type: array
          items:
            $ref: '#/components/schemas/DailyBalance_JSONObject'
        declinelist:
          type: array
          items:
            $ref: '#/components/schemas/declinelist_JSONObject'
        Daily Cash Flows:
          type: array
          items:
            $ref: '#/components/schemas/DailyCashflow_JSONObject'
        Monthly Cash Flows:
          type: array
          items:
            $ref: '#/components/schemas/DailyCashflow_JSONObject'
        Credit Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        True Credit Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Non-True Credit Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Incoming Transfers:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Outgoing Transfers:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Large Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Large Credit Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Returned Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Monthly Negative Days:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyNegativeDays_JSONObject'
        Monthly Recovery:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyRecovery_JSONObject'
        Large Incoming Electronic Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Transfers:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Non-True Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        True Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        MCA Companies:
          type: array
          items:
            $ref: '#/components/schemas/MCACompany'
        Recovery Companies:
          type: array
          items:
            $ref: '#/components/schemas/RecoveryCompany'
        Recovery Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Casino Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Investments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Mobile Payments:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Payment Processor Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Healthcare Claims:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Factoring:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Nefarious Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        All Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Other Financing Transactions:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Non-Transaction Items:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Payroll:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Tolls:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Nondescript Revenue:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
        Chinese Market Exposure:
          type: array
          items:
            $ref: '#/components/schemas/ScoreCardTransaction_JSONObject'
    Statements_Summary_Default:
      type: object
      properties:
        columns:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              data:
                type: string
        labels:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              name:
                type: string
        data:
          items:
            type: object
            properties:
              DT_RowId:
                type: string
              accountidx:
                type: string
                description: >-
                  The unique integer identifier of the account within this
                  scorecard.
              account:
                type: string
                description: >-
                  Account number.  It may be masked or made artificially unique
                  based on user settings.
              start_date:
                type: string
                description: The first date of statement in [MMM DD, YYYY] format.
              ending_date:
                type: string
                description: The last date of statement in [MMM DD, YYYY] format.
              statement_year:
                type: integer
                description: The statement year as an integer. For example, 2024.
              statement_month:
                type: string
                description: >-
                  The statement month as a full month string. For example,
                  "January".
              statement_month_num:
                type: integer
                description: The statement year as an integer. For example, 1.
              statement_month_num_and_name:
                type: string
                description: >-
                  The statement month as an integer and string. For example, "1
                  - January".
              fraud_score:
                type: integer
                description: The thumbprint fraud score as an integer.
              reconciled:
                type: string
                description: The statement reconciled indicator, true or false.
              total_credits:
                type: number
                description: The total currency value of all credits.
              true_credits:
                type: number
                description: The total currency value of all true credits.
              non-true_credits:
                type: number
                description: The total currency value of all non-true credits.
              num_credits:
                type: integer
                description: The number of credit transactions.
              num_true_credits:
                type: integer
                description: The number of true credit transactions.
              num_non-true_credits:
                type: integer
                description: THe number of non-true credit transactions.
              total_debits:
                type: number
                description: The total currency value of all debits.
              true_debits:
                type: number
                description: The total currency value of all true debits.
              non-true_debits:
                type: number
                description: The total currency value of all non-true debits.
              net_cashflow:
                type: number
                description: Total credits minus total debits.
              avg_balance:
                type: number
                description: The average daily balance during the statement period.
              min_balance:
                type: number
                description: The minimum daily balance during the statement period.
              avg_true_balance:
                type: number
                description: The average daily true balance during the statement period.
              starting_balance:
                type: number
                description: The starting balance of the statement.
              ending_balance:
                type: number
                description: The ending balance of the statement.
              balance_match:
                type: boolean
                description: >-
                  Indicates if the starting balance of this statement match the
                  ending balance of the previous one.
              month_gap:
                type: boolean
                description: >-
                  Indicates if there is a gap in dates between this statement
                  and the previous one.
              bank_name:
                type: string
                description: Name of the bank that produced this statement.
              account_owner:
                type: string
                description: Owner of the account as found on the statement.
              file_previously_seen:
                type: integer
                description: Shows the number of times a file was seen in the last 3 days.
              bank_address:
                type: string
                description: Shows the physical address of the bank.
              bank_city:
                type: string
                description: Shows the city where the bank is located.
              bank_state:
                type: string
                description: Shows the state where the bank is located.
              bank_zipcode:
                type: string
                description: Shows the zip code of the bank.
              days_neg:
                type: integer
                description: >-
                  The number of days with a negative balance during the
                  statement period.
              low_days:
                type: integer
                description: >-
                  The number of days with a low balance during the statement
                  period.
              num_nsfs:
                type: integer
                description: Number of NSF transactions.
              total_nsfs:
                type: number
                description: Currency amount of NSF transactions.
              num_ods:
                type: integer
                description: Number of overdrafts.
              total_overdraft_amount:
                type: number
                description: Currency amount of overdrafts.
              num_stops:
                type: integer
                description: Number of stop payments.
              days_w_returns:
                type: integer
                description: Number of days with return transactions.
              num_transfers:
                type: integer
                description: The number of transfers.
              transfers_total:
                type: number
                description: The total amount of transfers.
              num_incoming_transfers:
                type: integer
                description: The number of incoming transfers.
              total_incoming_transfers:
                type: number
                description: The total amount of incoming transfers.
              num_outgoing_transfers:
                type: integer
                description: The number of the outgoing transfers.
              total_outgoing_transfers:
                type: number
                description: The total amount of outgoing transfers.
              mca_debits:
                type: number
                description: Total amount of MCA debits in statements.
              mca_credits:
                type: number
                description: Total amount of MCA credits in statements.
              recovery_debits:
                type: number
                description: Total amount of recovery debits in statements.
              recovery_credits:
                type: number
                description: Total amount of recovery credits in statements.
              num_mcas:
                type: integer
                description: Number of MCA companies found.
              mca_withhold_percent:
                type: number
                description: Percentage of total MCA debits out of true credits.
              num_investments:
                type: integer
                description: Number of investment transactions.
              investments_total:
                type: number
                description: Currency value of investment transactions.
              num_mobile_payments:
                type: integer
                description: Count of mobile payments.
              mobile_payments_total:
                type: number
                description: Total amount of mobile payments.
              num_factoring:
                type: integer
                description: The number of factoring transactions.
              factoring_total:
                type: number
              num_nefarious_transactions:
                type: integer
                description: The number of nefarious transactions.
              nefarious_transactions_total:
                type: number
                description: The total amount of nefarious transactions.
              num_other_financing_transactions:
                type: integer
                description: The number of other financing transactions.
              other_financing_transactions_total:
                type: number
                description: The total amount of other financing transactions.
              num_payroll:
                type: integer
                description: The number of payroll transactions.
              payroll_total:
                type: number
                description: The total amount of payroll transactions.
              num_healthcare_claims:
                type: integer
                description: The number of healthcare claim transactions.
              healthcare_claims_total:
                type: number
                description: The total amount of healthcare claim transactions.
              num_tolls:
                type: integer
                description: The number of toll transactions.
              tolls_total:
                type: number
                description: The total amount of toll transactions.
              num_payment_processor_transactions:
                type: integer
                description: The number of payment processor transactions.
              total_payment_processor_transactions:
                type: integer
                description: The total amount of payment processor transactions.
              total_nondescript_revenue:
                type: number
                description: The total amount of nondescript revenue transactions.
              num_nondescript_revenue_transactions:
                type: integer
                description: The number of nondescript revenue transactions.
              total_non-mca_loans:
                type: number
                description: The total amount of non-MCA loan transactions.
              number_of_non-mca_loan_transactions:
                type: number
                description: The total number of non-MCA loan transactions.
              num_mca_loan_payments:
                type: integer
                description: The number of MCA loan payments.
              total_mca_loan_payments:
                type: number
                description: The total amount of MCA loan payments.
              num_mobile_payment_debit:
                type: integer
                description: The number of mobile payment debits.
              total_mobile_payment_debit:
                type: number
                description: The total amount of mobile payment debits.
              num_nefarious_withdrawals:
                type: integer
                description: The number of nefarious withdrawals.
              total_nefarious_withdrawal:
                type: number
                description: The total amount of nefarious withdrawals.
              num_debt_collector:
                type: integer
                description: The number of debt collectors.
              total_debt_collector:
                type: number
                description: The total amount of debt collectors.
              num_atm_withdrawals:
                type: integer
                description: The number of ATM withdrawals.
              total_atm_withdrawals:
                type: number
                description: The total amount of ATM withdrawals.
              num_construction_debits:
                type: integer
                description: The number of construction debits.
              total_construction_debits:
                type: number
                description: The total amount of construction debits.
              num_insurance:
                type: integer
                description: The number of insurance transactions.
              total_insurance:
                type: number
                description: The total amount of insurance transactions.
              num_of_returns:
                type: integer
                description: The number of returns.
              total_returns:
                type: number
                description: The total amount of returns.
              num_of_other_debits:
                type: integer
                description: The number of other debits.
              total_other_debits:
                type: number
                description: The total amount of other debits.
    Combined_Summary_Default:
      type: object
      properties:
        columns:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              data:
                type: string
        labels:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              name:
                type: string
        data:
          items:
            type: object
            properties:
              DT_RowId:
                type: string
              month:
                type: string
                description: Month and year
                example: February 2020
              daysMissing:
                type: integer
              totalcredits:
                type: number
                description: The total currency value of all credits.
              totaltruecredits:
                type: number
                description: The total currency value of all true credits.
              totaladjcredits:
                type: number
                description: The total currency value of all non-true credits.
              numbercredits:
                type: integer
                description: The number of credit transactions.
              numbertruecredits:
                type: integer
                description: The number of true credit transactions.
              numberadjcredits:
                type: integer
                description: The number of non-true credit transactions.
              totaldebits:
                type: number
                description: The total currency value of all debits.
              totaltruedebits:
                type: number
                description: The total currency value of all true debits.
              totaladjdebits:
                type: number
                description: The total currency value of all non-true debits.
              numberdebits:
                type: integer
                description: The number of debit transactions.
              numbertruedebits:
                type: integer
                description: The number of true debit transactions.
              numberadjdebits:
                type: integer
                description: The number of non-true debit transactions.
              averagebalance:
                type: number
                description: The average daily balance during the month.
              averagetruebalance:
                type: number
                description: The average daily true balance during the month.
              startbalance:
                type: number
                description: The starting balance of the month.
              endbalance:
                type: number
                description: The ending balance of the month.
              daysnegative:
                type: integer
                description: The number of days with a negative balance during the month.
              dayslow:
                type: integer
                description: The number of days with a low balance during the month.
              numbernsf:
                type: integer
                description: The number of NSF transactions for the month.
              numberod:
                type: integer
                description: Number of overdrafts for the month.
              numberstops:
                type: integer
                description: Number of stop payments for the month.
              dayswithreturns:
                type: integer
                description: The number of days with return transactions for the month.
              numbertransfers:
                type: integer
                description: The number of transfers.
              numbertransfersincoming:
                type: integer
                description: The number of incoming transfers.
              numbertransfersoutgoing:
                type: integer
                description: The number of the outgoing transfers.
              nummca:
                type: integer
                description: Number of MCA companies found.
              mcadebits:
                type: number
                description: Total amount of MCA debits for the month.
              mcacredits:
                type: number
                description: The total amount of MCA credits for the month.
              recoverydebits:
                type: number
                description: The total amount of recovery debits for the month.
              recoverycredits:
                type: number
                description: Total amount of recovery credits for the month.
              transferstotal:
                type: number
                description: The total amount of transfers for the month.
              outgoingtransferstotal:
                type: number
                description: The number of the outgoing transfers for the month.
              incomingtransferstotal:
                type: number
                description: The total amount of incoming transfers for the month.
              minimumbalance:
                type: number
                description: The minimum daily balance during the month.
              investmentscount:
                type: integer
                description: The number of investment transactions for the month.
              investmentstotal:
                type: number
                description: Currency value of investment transactions for the month.
              mobilepaymentscount:
                type: integer
                description: The number of mobile payments credits for the month.
              mobilepaymentstotal:
                type: number
                description: The total amount of mobile payments for the month.
    Statements_Summary_JSONObject:
      type: object
      properties:
        accountidx:
          type: string
          description: The unique integer identifier of the account within this scorecard.
        Account:
          type: string
          description: >-
            Account number.  It may be masked or made artificially unique based
            on user settings.
        Start Date:
          type: string
          description: The first date of statement in [MMM DD, YYYY] format.
        Ending Date:
          type: string
          description: The last date of statement in [MMM DD, YYYY] format.
        Statement Year:
          type: integer
          description: The statement year as an integer. For example, 2024.
        Statement Month:
          type: string
          description: The statement month as a full month string. For example, "January".
        Statement Month Num:
          type: integer
          description: The statement year as an integer. For example, 1.
        Statement Month Num and Name:
          type: string
          description: >-
            The statement month as an integer and string. For example, "1 -
            January".
        Fraud Score:
          type: integer
          description: The thumbprint fraud score as an integer.
        Reconciled:
          type: string
          description: The statement reconciled indicator, true or false.
        Total Credits:
          type: number
          description: The total currency value of all credits.
        True Credits:
          type: number
          description: The total currency value of all true credits.
        Non True Credits:
          type: number
          description: The total currency value of all non-true credits.
        Num Credits:
          type: integer
          description: The number of credit transactions.
        Num True Credits:
          type: integer
          description: The number of true credit transactions.
        Num Non-True Credits:
          type: integer
          description: THe number of non-true credit transactions.
        Total Debits:
          type: number
          description: The total currency value of all debits.
        True Debits:
          type: number
          description: The total currency value of all true debits.
        Non True Debits:
          type: number
          description: The total currency value of all non-true debits.
        Net Cashflow:
          type: number
          description: Total credits minus total debits.
        Avg Balance:
          type: number
          description: The average daily balance during the statement period.
        Min Balance:
          type: number
          description: The minimum daily balance during the statement period.
        Avg True Balance:
          type: number
          description: The average daily true balance during the statement period.
        Starting Balance:
          type: number
          description: The starting balance of the statement.
        Ending Balance:
          type: number
          description: The ending balance of the statement.
        Balance Match:
          type: boolean
          description: >-
            Indicates if the starting balance of this statement match the ending
            balance of the previous one
        Month Gap:
          type: boolean
          description: >-
            Indicates if there is a gap in dates between this statement and the
            previous one.
        Bank Name:
          type: string
          description: Name of the bank that produced this statement.
        Account Owner:
          type: string
          description: Owner of the account as found on the statement.
        File Previously Seen:
          type: integer
          description: Shows the number of times a file was seen in the last 3 days.
        Bank Address:
          type: string
          description: Shows the physical address of the bank.
        Bank City:
          type: string
          description: Shows the city where the bank is located.
        Bank State:
          type: string
          description: Shows the state where the bank is located.
        Bank Zipcode:
          type: string
          description: Shows the zip code of the bank.
        Days Neg:
          type: integer
          description: >-
            The number of days with a negative balance during the statement
            period.
        Low Days:
          type: integer
          description: The number of days with a low balance during the statement period.
        Num NSFs:
          type: integer
          description: Number of NSF transactions.
        Total NSFs:
          type: number
          description: Currency amount of NSF transactions.
        Num ODs:
          type: integer
          description: Number of overdrafts.
        Total Overdraft Amount:
          type: number
          description: Currency amount of overdrafts.
        Num Stops:
          type: integer
          description: Number of stop payments.
        Days w/ Returns:
          type: integer
          description: Number of days with return transactions.
        Num Transfers:
          type: integer
          description: The number of transfers.
        Transfers Total:
          type: number
          description: The total amount of transfers.
        Num Incoming Transfers:
          type: integer
          description: The number of incoming transfers.
        Total Incoming Transfers:
          type: number
          description: The total amount of incoming transfers.
        Num Outgoing Transfers:
          type: integer
          description: The number of the outgoing transfers.
        Total Outgoing Transfers:
          type: number
          description: The total amount of outgoing transfers.
        MCA Debits:
          type: number
          description: Total amount of MCA debits in statements.
        MCA Credits:
          type: number
          description: Total amount of MCA credits in statements.
        Recovery Debits:
          type: number
          description: Total amount of recovery debits in statements.
        Recovery Credits:
          type: number
          description: Total amount of recovery credits in statements.
        Num MCAs:
          type: integer
          description: Number of MCA companies found.
        MCA Withhold Percent:
          type: number
          description: Percentage of total MCA debits out of true credits.
        Num Investments:
          type: integer
          description: Number of investment transactions.
        Investments Total:
          type: number
          description: Currency value of investment transactions.
        Num Mobile Payments:
          type: integer
          description: Count of mobile payments.
        Mobile Payments Total:
          type: number
          description: Total amount of mobile payments.
        Num Factoring:
          type: integer
          description: The number of factoring transactions.
        Factoring Total:
          type: number
          description: The total amount of factoring transactions.
        Num Nefarious Transactions:
          type: integer
          description: The number of nefarious transactions.
        Nefarious Transactions Total:
          type: number
          description: The total amount of nefarious transactions.
        Num Other Financing Transactions:
          type: integer
          description: The number of other financing transactions.
        Other Financing Transactions Total:
          type: number
        Num Payroll:
          type: integer
          description: The number of payroll transactions.
        Payroll Total:
          type: number
          description: The total amount of payroll transactions.
        Num Healthcare claims:
          type: integer
          description: The number of healthcare claim transactions.
        Healthcare Claims Total:
          type: number
          description: The total amount of healthcare claim transactions.
        Num Tolls:
          type: integer
          description: The number of toll transactions.
        Tolls Total:
          type: number
          description: The total amount of toll transactions.
        Num Payment Processor Transactions:
          type: integer
          description: The number of payment processor transactions.
        total_payment_processor_transactions:
          type: number
          description: The total amount of payment processor transactions.
        total_nondescript_revenue:
          type: number
          description: The total amount of nondescript revenue transactions.
        Num Nondescript Revenue Transactions:
          type: integer
          description: The number of nondescript revenue transactions.
        Total Non-MCA Loans:
          type: number
          description: The total amount of non-MCA loan transactions.
        Number of Non-MCA Loan Transactions:
          type: number
          description: The total number of non-MCA loan transactions.
        Num MCA Loan Payments:
          type: integer
          description: The number of MCA loan payments.
        Total MCA Loan Payments:
          type: number
          description: The total amount of MCA loan payments.
        Num Mobile Payment Debit:
          type: integer
          description: The number of mobile payment debits.
        Total Mobile Payment Debit:
          type: number
          description: The total amount of mobile payment debits.
        Num Nefarious Withdrawals:
          type: integer
          description: The number of nefarious withdrawals.
        Total Nefarious Withdrawal:
          type: number
          description: The total amount of nefarious withdrawals.
        Num Debt Collector:
          type: integer
          description: The number of debt collectors.
        Total Debt Collector:
          type: number
          description: The total amount of debt collectors.
        Num ATM Withdrawals:
          type: integer
          description: The number of ATM withdrawals.
        Total ATM Withdrawals:
          type: number
          description: The total amount of ATM withdrawals.
        Num Construction Debits:
          type: integer
          description: The number of construction debits.
        Total Construction Debits:
          type: number
          description: The total amount of construction debits.
        Num Insurance:
          type: integer
          description: The number of insurance transactions.
        Total Insurance:
          type: number
          description: The total amount of insurance transactions.
        Num of Returns:
          type: integer
          description: The number of returns.
        Total Returns:
          type: number
          description: The total amount of returns.
        Num of Other Debits:
          type: integer
          description: The number of other debits.
        Total Other Debits:
          type: number
          description: The total amount of other debits.
    Thumbprint:
      type: object
      properties:
        account:
          type: string
          description: Statement account
        end_date:
          type: string
          description: Statement end date
        thumbprint_score:
          type: integer
          description: Thumbprint score
        contributing_factors:
          type: string
          description: Factors that contributed to the Thumbprint score
        statement_id:
          type: integer
          description: Statement identifier
    AccountJSON:
      type: object
      properties:
        Account Name:
          type: string
          description: The name for the account.
        Account Number:
          type: string
          description: The number of the account.
        Statements:
          type: array
          items:
            $ref: '#/components/schemas/StatementJSON'
      description: Account Object
    Transaction:
      type: object
      properties:
        date:
          type: string
          description: The date of the transaction.
          format: date
        description:
          type: string
          description: The description of the transaction.
        amount:
          type: number
          description: The amount of the transaction.
        memo:
          type: string
          description: The memo from the transacation.
        checknumber:
          type: integer
          description: Check number
          format: int32
        type:
          type: string
          description: >-
            The type of transaction. It could be Debit or Credit. It only has a
            value when `showtranstype = true`.
        id:
          type: integer
          description: The Unique ID of the transaction.
          format: int32
        possible:
          type: boolean
          description: Internal use only.
        trueval:
          type: boolean
          description: Shows whether the transactions are considered true revenue.
        balance:
          type: number
          description: Account balance. This is only present if `includebalance = true`.
        tags:
          type: array
          description: >-
            List of tags for a transaction. This appears if `includetransactions
            = true`.
          items:
            type: object
            properties:
              tagName:
                type: string
                description: >-
                  The [scorecard
                  section](https://docs.moneythumb.com/pdf-insights/scorecard)
                  name the transaction falls under.
              metadata:
                type: string
                description: Only populates when `tagName` section includes company names.
              company:
                type: string
                description: Name of company from transaction.
        customerId:
          type: string
          description: >-
            User-provided ID for this transaction that will return unchanged in
            the results. This appears if `includetransactions = true`.
      description: Transaction Object
    StatementJSON:
      type: object
      properties:
        statementid:
          type: integer
          description: The internal ID for the statement.
          format: int32
        startdate:
          type: string
          description: The statement start date in ISO 8601 format.
        enddate:
          type: string
          description: The statement end date in ISO 8601 format.
        Transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
      description: List of statements for the account
    FileConversionResult:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/DocumentResult'
        logurl:
          type: string
          description: The location of the log file for conversions.
        csvurl:
          type: string
          description: The location of the CSV file of transactions.
          deprecated: true
        error:
          type: string
          description: Error message
        tid:
          type: string
          description: The internal tracking ID.
        outputurl:
          type: string
          description: The URL of the output (for Accounting applications only).
        statementid:
          type: integer
          description: Use `statementid` in results object instead.
          format: int32
          deprecated: true
        convertedstatements:
          type: integer
          description: The count of converted statements.
          format: int32
        convertedtaxforms:
          type: integer
          description: The count of converted tax forms.
          format: int32
        taxform:
          type: string
          description: The tax form number.
        taxsales:
          type: string
          description: Tax sales
        taxgross:
          type: string
          description: Tax gross
        taxincome:
          type: string
          description: Tax income
        taxableincome:
          type: string
          description: Taxable income
        statementseq:
          type: integer
          description: >-
            The sequence number of this statement in last conversion list (0
            based).
          format: int32
    UploadPDFsResponse_Default:
      type: object
      title: Default
      properties:
        statement_summaries:
          type: array
          items:
            $ref: '#/components/schemas/FileConversionResult'
        appinfo:
          $ref: '#/components/schemas/ApplicationInfo'
        scorecard:
          $ref: '#/components/schemas/ScoreCardObject_Default'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/AccountJSON'
      description: Multi-File Results Object
    UploadPDFsResponse_JSONObject:
      title: JSONObject
      type: object
      properties:
        statement_summaries:
          type: array
          items:
            $ref: '#/components/schemas/FileConversionResult'
        appinfo:
          $ref: '#/components/schemas/ApplicationInfo'
        scorecard:
          $ref: '#/components/schemas/ScoreCardObject_JSONObject'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/AccountJSON'
